<!DOCTYPE html>
<html lang="en">
<head>
  <title>Cheatsheets - Vert.x</title>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta content="width=device-width, initial-scale=1.0" name="viewport">
  <meta content="Vert.x is a tool-kit for building reactive applications on the JVM." name="description">
  <link href="http://vertx.io/stylesheets/docs.css" media="screen" rel="stylesheet">
  <link href="http://vertx.io/stylesheets/font-awesome.min.css" media="screen" rel="stylesheet">
  <link href="http://vertx.io/javascripts/styles/rainbow.min.css" media="screen" rel="stylesheet">
  <!-- IE 6-8 support of HTML 5 elements -->
  <!--[if lt IE 9]>
  <script src="http://static.jboss.org/theme/js/libs/html5/pre3.6/html5.min.js"></script>
  <![endif]-->

  <link rel="apple-touch-icon" sizes="57x57" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-57x57.png">
  <link rel="apple-touch-icon" sizes="60x60" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-60x60.png">
  <link rel="apple-touch-icon" sizes="72x72" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-72x72.png">
  <link rel="apple-touch-icon" sizes="76x76" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-76x76.png">
  <link rel="apple-touch-icon" sizes="114x114" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-114x114.png">
  <link rel="apple-touch-icon" sizes="120x120" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-120x120.png">
  <link rel="apple-touch-icon" sizes="144x144" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-144x144.png">
  <link rel="apple-touch-icon" sizes="152x152" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-152x152.png">
  <link rel="apple-touch-icon" sizes="180x180" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-180x180.png">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/favicon-32x32.png" sizes="32x32">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/android-chrome-192x192.png" sizes="192x192">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/favicon-96x96.png" sizes="96x96">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/favicon-16x16.png" sizes="16x16">
  <link rel="manifest" href="http://vertx.io/assets/favicons/vertx-favicon-7/manifest.json">
  <link rel="mask-icon" href="http://vertx.io/assets/favicons/vertx-favicon-7/safari-pinned-tab.svg" color="#5bbad5">
  <meta name="msapplication-TileColor" content="#7d3194">
  <meta name="msapplication-TileImage" content="http://vertx.io/assets/favicons/vertx-favicon-7/mstile-144x144.png">
  <meta name="theme-color" content="#ffffff">

  <link href="http://fonts.googleapis.com/css?family=Ubuntu:400,500,700,400italic" rel="stylesheet" type="text/css">
  <link rel="alternate" type="application/rss+xml" title="RSS"
     href="http://vertx.io/feed.xml">
  <script>
    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
    })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
    ga('create', 'UA-30144458-1', 'auto');
    ga('create', 'UA-71153120-1', 'auto', 'tracker');
    ga('send', 'pageview');
    ga('tracker.send', 'pageview');
  </script>
</head>
<body>

<a href="http://www.reactivemanifesto.org/" id="reactive-manifesto-banner">
  <img style="border: 0; position: fixed; right: 0; top:0; z-index: 9000"
    src="http://d379ifj7s9wntv.cloudfront.net/reactivemanifesto/images/ribbons/we-are-reactive-black-right.png">
</a>

<a id="skippy" class="sr-only sr-only-focusable" href="#content"><div class="container"><span class="skiplink-text">Skip to main content</span></div></a>

<header class="navbar navbar-default navbar-static-top" id="top" role="banner">
  <div class="container">
    <div class="navbar-header">
      <button class="navbar-toggle collapsed" type="button" data-toggle="collapse" data-target="#vertx-navbar-collapse">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <a href="http://vertx.io/" class="navbar-brand"><img alt="Brand" src="http://vertx.io/assets/logo-sm.png"></a>
    </div>
    <nav class="collapse navbar-collapse" id="vertx-navbar-collapse">
      <ul class="nav navbar-nav navbar-right">
        <li><a href="http://vertx.io/download/">Download</a></li>
        <li><a href="http://vertx.io/docs/">Documentation</a></li>
        <li><a href="https://github.com/vert-x3/wiki/wiki">Wiki</a></li>
        <li><a href="http://vertx.io/community/">Community</a></li>
        <li><a href="http://vertx.io/materials/">Materials</a></li>
        <li><a href="http://vertx.io/blog/">Blog</a></li>        
      </ul>
    </nav>
  </div>
</header>



  <div class="page-header" id="content">
    <div class="container">
      <div class="row">
        <div class="col-sm-12">
          <h1>Cheatsheets</h1>
          
        </div>
      </div>
    </div>
  </div>




<div id="content">
  <div class="container docs-content">
    <div class="row">
      <div class="col-sm-12 col-md-push-9 col-md-3 hidden-xs hidden-sm">
        <div id="sidebar" data-spy="affix">
          <ul class="sectlevel1">
<li><a href="#AddressResolverOptions">AddressResolverOptions</a></li>
<li><a href="#Argument">Argument</a></li>
<li><a href="#ClientOptionsBase">ClientOptionsBase</a></li>
<li><a href="#DatagramSocketOptions">DatagramSocketOptions</a></li>
<li><a href="#DeliveryOptions">DeliveryOptions</a></li>
<li><a href="#DeploymentOptions">DeploymentOptions</a></li>
<li><a href="#EventBusOptions">EventBusOptions</a></li>
<li><a href="#GoAway">GoAway</a></li>
<li><a href="#Http2Settings">Http2Settings</a></li>
<li><a href="#HttpClientOptions">HttpClientOptions</a></li>
<li><a href="#HttpServerOptions">HttpServerOptions</a></li>
<li><a href="#JdkSSLEngineOptions">JdkSSLEngineOptions</a></li>
<li><a href="#JksOptions">JksOptions</a></li>
<li><a href="#MetricsOptions">MetricsOptions</a></li>
<li><a href="#NetClientOptions">NetClientOptions</a></li>
<li><a href="#NetServerOptions">NetServerOptions</a></li>
<li><a href="#NetworkOptions">NetworkOptions</a></li>
<li><a href="#OpenOptions">OpenOptions</a></li>
<li><a href="#OpenSSLEngineOptions">OpenSSLEngineOptions</a></li>
<li><a href="#Option">Option</a></li>
<li><a href="#PemKeyCertOptions">PemKeyCertOptions</a></li>
<li><a href="#PemTrustOptions">PemTrustOptions</a></li>
<li><a href="#PfxOptions">PfxOptions</a></li>
<li><a href="#ProxyOptions">ProxyOptions</a></li>
<li><a href="#TCPSSLOptions">TCPSSLOptions</a></li>
<li><a href="#VertxOptions">VertxOptions</a></li>
</ul>
        </div>
      </div>
      <div class="col-sm-12 col-md-pull-3 col-md-9">
        <div class="toc hidden-md hidden-lg">
          <h2>Table of Contents</h2>
          <ul class="sectlevel1">
<li><a href="#AddressResolverOptions">AddressResolverOptions</a></li>
<li><a href="#Argument">Argument</a></li>
<li><a href="#ClientOptionsBase">ClientOptionsBase</a></li>
<li><a href="#DatagramSocketOptions">DatagramSocketOptions</a></li>
<li><a href="#DeliveryOptions">DeliveryOptions</a></li>
<li><a href="#DeploymentOptions">DeploymentOptions</a></li>
<li><a href="#EventBusOptions">EventBusOptions</a></li>
<li><a href="#GoAway">GoAway</a></li>
<li><a href="#Http2Settings">Http2Settings</a></li>
<li><a href="#HttpClientOptions">HttpClientOptions</a></li>
<li><a href="#HttpServerOptions">HttpServerOptions</a></li>
<li><a href="#JdkSSLEngineOptions">JdkSSLEngineOptions</a></li>
<li><a href="#JksOptions">JksOptions</a></li>
<li><a href="#MetricsOptions">MetricsOptions</a></li>
<li><a href="#NetClientOptions">NetClientOptions</a></li>
<li><a href="#NetServerOptions">NetServerOptions</a></li>
<li><a href="#NetworkOptions">NetworkOptions</a></li>
<li><a href="#OpenOptions">OpenOptions</a></li>
<li><a href="#OpenSSLEngineOptions">OpenSSLEngineOptions</a></li>
<li><a href="#Option">Option</a></li>
<li><a href="#PemKeyCertOptions">PemKeyCertOptions</a></li>
<li><a href="#PemTrustOptions">PemTrustOptions</a></li>
<li><a href="#PfxOptions">PfxOptions</a></li>
<li><a href="#ProxyOptions">ProxyOptions</a></li>
<li><a href="#TCPSSLOptions">TCPSSLOptions</a></li>
<li><a href="#VertxOptions">VertxOptions</a></li>
</ul>
        </div>
        <div class="sect1">
<h2 id="AddressResolverOptions">AddressResolverOptions</h2>
<div class="sectionbody">
 Configuration options for Vert.x hostname resolver. The resolver uses the local <i>hosts</i> file and performs
 DNS <i>A</i> and <i>AAAA</i> queries.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="cacheMaxTimeToLive"></a><code>cacheMaxTimeToLive</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the cache maximum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL,
 use this to set a maximum value to all responses TTL.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="cacheMinTimeToLive"></a><code>cacheMinTimeToLive</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the cache minimum TTL value in seconds. After resolution successful IP addresses are cached with their DNS response TTL,
 use this to set a minimum value to all responses TTL.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="cacheNegativeTimeToLive"></a><code>cacheNegativeTimeToLive</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the negative cache TTL value in seconds. After a failed hostname resolution, DNS queries won't be retried
 for a period of time equals to the negative TTL. This allows to reduce the response time of negative replies
 and reduce the amount of messages to DNS servers.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="hostsPath"></a><code>hostsPath</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the path of an alternate hosts configuration file to use instead of the one provided by the os.
 <p/>
 The default value is null, so the operating system hosts config is used.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="hostsValue"></a><code>hostsValue</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set an alternate hosts configuration file to use instead of the one provided by the os.
 <p/>
 The value should contain the hosts content literaly, for instance <i>127.0.0.1 localhost</i>
 <p/>
 The default value is null, so the operating system hosts config is used.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxQueries"></a><code>maxQueries</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the maximum number of queries when an hostname is resolved.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="ndots"></a><code>ndots</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the ndots value used when resolving using search domains, the default value is <code>-1</code> which
 determines the value from the OS on Linux or uses the value <code>1</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="optResourceEnabled"></a><code>optResourceEnabled</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to true to enable the automatic inclusion in DNS queries of an optional record that hints
 the remote DNS server about how much data the resolver can read per response.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="queryTimeout"></a><code>queryTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="rdFlag"></a><code>rdFlag</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the DNS queries <i>Recursion Desired</i> flag value.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="searchDomains"></a><code>searchDomains</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the lists of DNS search domains.
 <p/>
 When the search domain list is null, the effective search domain list will be populated using
 the system DNS search domains.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="servers"></a><code>servers</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the list of DNS server addresses, an address is the IP  of the dns server, followed by an optional
 colon and a port, e.g <code>8.8.8.8</code> or {code 192.168.0.1:40000}. When the list is empty, the resolver
 will use the list of the system DNS server addresses from the environment, if that list cannot be retrieved
 it will use Google's public DNS servers <code>"8.8.8.8"</code> and <code>"8.8.4.4"</code>.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="Argument">Argument</h2>
<div class="sectionbody">
 Defines a command line argument. Unlike options, argument don't have names and are identified using an index. The
 first index is 0 (because we are in the computer world).
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="argName"></a><code>argName</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the argument name of this link.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="defaultValue"></a><code>defaultValue</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the default value of this link.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="description"></a><code>description</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the description of the link.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="hidden"></a><code>hidden</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets whether or not the current link is hidden.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="index"></a><code>index</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the argument index.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="multiValued"></a><code>multiValued</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets whether or not the argument can receive several values. Only the last argument can receive several values.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="required"></a><code>required</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets whether or not the current link is required.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="ClientOptionsBase">ClientOptionsBase</h2>
<div class="sectionbody">
 Base class for Client options
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="connectTimeout"></a><code>connectTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the connect timeout</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlPaths"></a><code>crlPaths</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL path</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlValues"></a><code>crlValues</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL value</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledCipherSuites"></a><code>enabledCipherSuites</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled cipher suite, appended to the ordered suites.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledSecureTransportProtocols"></a><code>enabledSecureTransportProtocols</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled SSL/TLS protocols, appended to the ordered protocols.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="idleTimeout"></a><code>idleTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the idle timeout, in seconds. zero means don't timeout.
 This determines if a connection will timeout and be closed if no data is received within the timeout.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="jdkSslEngineOptions"></a><code>jdkSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JdkSSLEngineOptions">JdkSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="keyStoreOptions"></a><code>keyStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in jks format, aka Java keystore.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="logActivity"></a><code>logActivity</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="metricsName"></a><code>metricsName</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the metrics name identifying the reported metrics, useful for grouping metrics
 with the same name.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="openSslEngineOptions"></a><code>openSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#OpenSSLEngineOptions">OpenSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemKeyCertOptions"></a><code>pemKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemKeyCertOptions">PemKeyCertOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert store options in pem format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemTrustOptions"></a><code>pemTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemTrustOptions">PemTrustOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pem format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxKeyCertOptions"></a><code>pfxKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in pfx format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxTrustOptions"></a><code>pfxTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pfx format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="proxyOptions"></a><code>proxyOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#ProxyOptions">ProxyOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="receiveBufferSize"></a><code>receiveBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP receive buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reuseAddress"></a><code>reuseAddress</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of reuse address</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sendBufferSize"></a><code>sendBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP send buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="soLinger"></a><code>soLinger</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SO_linger keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="ssl"></a><code>ssl</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SSL/TLS is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpKeepAlive"></a><code>tcpKeepAlive</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpNoDelay"></a><code>tcpNoDelay</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP no delay is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trafficClass"></a><code>trafficClass</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of traffic class</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trustAll"></a><code>trustAll</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether all server certificates should be trusted</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trustStoreOptions"></a><code>trustStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in jks format, aka Java trustore</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="useAlpn"></a><code>useAlpn</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the ALPN usage.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="usePooledBuffers"></a><code>usePooledBuffers</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether Netty pooled buffers are enabled</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="DatagramSocketOptions">DatagramSocketOptions</h2>
<div class="sectionbody">
 Options used to configure a datagram socket.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="broadcast"></a><code>broadcast</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set if the socket can receive broadcast packets</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="ipV6"></a><code>ipV6</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set if IP v6 should be used</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="logActivity"></a><code>logActivity</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="loopbackModeDisabled"></a><code>loopbackModeDisabled</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set if loopback mode is disabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="multicastNetworkInterface"></a><code>multicastNetworkInterface</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the multicast network interface address</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="multicastTimeToLive"></a><code>multicastTimeToLive</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the multicast ttl value</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="receiveBufferSize"></a><code>receiveBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP receive buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reuseAddress"></a><code>reuseAddress</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of reuse address</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sendBufferSize"></a><code>sendBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP send buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trafficClass"></a><code>trafficClass</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of traffic class</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="DeliveryOptions">DeliveryOptions</h2>
<div class="sectionbody">
 Delivery options are used to configure message delivery.
 <p>
 Delivery options allow to configure delivery timeout and message codec name, and to provide any headers
 that you wish to send with the message.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="codecName"></a><code>codecName</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the codec name.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="headers"></a><code>headers</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a message header.
 <p>
 Message headers can be sent with any message and will be accessible with link
 at the recipient.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sendTimeout"></a><code>sendTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the send timeout.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="DeploymentOptions">DeploymentOptions</h2>
<div class="sectionbody">
 Options for configuring a verticle deployment.
 <p>
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="config"></a><code>config</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Json object</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the JSON configuration that will be passed to the verticle(s) when it's deployed</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="extraClasspath"></a><code>extraClasspath</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set any extra classpath to be used when deploying the verticle.
 <p>
 Ignored if no isolation group is set.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="ha"></a><code>ha</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether the verticle(s) will be deployed as HA.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="instances"></a><code>instances</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the number of instances that should be deployed.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="isolatedClasses"></a><code>isolatedClasses</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the isolated class names.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="isolationGroup"></a><code>isolationGroup</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the isolation group that will be used when deploying the verticle(s)</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxWorkerExecuteTime"></a><code>maxWorkerExecuteTime</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the value of max worker execute time, in ns.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="multiThreaded"></a><code>multiThreaded</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether the verticle(s) should be deployed as a multi-threaded worker verticle</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="worker"></a><code>worker</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether the verticle(s) should be deployed as a worker verticle</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="workerPoolName"></a><code>workerPoolName</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the worker pool name to use for this verticle. When no name is set, the Vert.x
 worker pool will be used, when a name is set, the verticle will use a named worker pool.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="workerPoolSize"></a><code>workerPoolSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the maximum number of worker threads to be used by the Vert.x instance.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="EventBusOptions">EventBusOptions</h2>
<div class="sectionbody">
 Options to configure the event bus.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="acceptBacklog"></a><code>acceptBacklog</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the accept back log.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clientAuth"></a><code>clientAuth</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="enums.html#ClientAuth">ClientAuth</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether client auth is required</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clusterPingInterval"></a><code>clusterPingInterval</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of cluster ping interval, in ms.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clusterPingReplyInterval"></a><code>clusterPingReplyInterval</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of cluster ping reply interval, in ms.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clusterPublicHost"></a><code>clusterPublicHost</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the public facing hostname to be used for clustering.
 Sometimes, e.g. when running on certain clouds, the local address the server listens on for clustering is
 not the same address that other nodes connect to it at, as the OS / cloud infrastructure does some kind of
 proxying. If this is the case you can specify a public hostname which is different from the hostname the
 server listens at.
 <p>
 The default value is null which means use the same as the cluster hostname.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clusterPublicPort"></a><code>clusterPublicPort</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">See link for an explanation.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clustered"></a><code>clustered</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets whether or not the event bus is clustered.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="connectTimeout"></a><code>connectTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the connect timeout</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlPaths"></a><code>crlPaths</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL path</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlValues"></a><code>crlValues</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL value</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledCipherSuites"></a><code>enabledCipherSuites</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled cipher suite, appended to the ordered suites.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledSecureTransportProtocols"></a><code>enabledSecureTransportProtocols</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled SSL/TLS protocols, appended to the ordered protocols.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="host"></a><code>host</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the host.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="idleTimeout"></a><code>idleTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the idle timeout, in seconds. zero means don't timeout.
 This determines if a connection will timeout and be closed if no data is received within the timeout.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="jdkSslEngineOptions"></a><code>jdkSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JdkSSLEngineOptions">JdkSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="keyStoreOptions"></a><code>keyStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in jks format, aka Java keystore.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="logActivity"></a><code>logActivity</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="openSslEngineOptions"></a><code>openSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#OpenSSLEngineOptions">OpenSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemKeyCertOptions"></a><code>pemKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemKeyCertOptions">PemKeyCertOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert store options in pem format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemTrustOptions"></a><code>pemTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemTrustOptions">PemTrustOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pem format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxKeyCertOptions"></a><code>pfxKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in pfx format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxTrustOptions"></a><code>pfxTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pfx format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="port"></a><code>port</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the port.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="receiveBufferSize"></a><code>receiveBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP receive buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reconnectAttempts"></a><code>reconnectAttempts</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the value of reconnect attempts.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reconnectInterval"></a><code>reconnectInterval</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the reconnect interval.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reuseAddress"></a><code>reuseAddress</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of reuse address</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sendBufferSize"></a><code>sendBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP send buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="soLinger"></a><code>soLinger</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SO_linger keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="ssl"></a><code>ssl</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SSL/TLS is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpKeepAlive"></a><code>tcpKeepAlive</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpNoDelay"></a><code>tcpNoDelay</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP no delay is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trafficClass"></a><code>trafficClass</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of traffic class</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trustAll"></a><code>trustAll</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether all server certificates should be trusted.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trustStoreOptions"></a><code>trustStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in jks format, aka Java trustore</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="useAlpn"></a><code>useAlpn</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the ALPN usage.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="usePooledBuffers"></a><code>usePooledBuffers</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether Netty pooled buffers are enabled</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="GoAway">GoAway</h2>
<div class="sectionbody">
 A  frame.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="debugData"></a><code>debugData</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the additional debug data</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="errorCode"></a><code>errorCode</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="lastStreamId"></a><code>lastStreamId</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the last stream id.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="Http2Settings">Http2Settings</h2>
<div class="sectionbody">
 HTTP2 settings, the settings is initialized with the default HTTP/2 values.<p>

 The settings expose the parameters defined by the HTTP/2 specification, as well as extra settings for
 protocol extensions.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="headerTableSize"></a><code>headerTableSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set  HTTP/2 setting.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="initialWindowSize"></a><code>initialWindowSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the  HTTP/2 setting</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxConcurrentStreams"></a><code>maxConcurrentStreams</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the  HTTP/2 setting</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxFrameSize"></a><code>maxFrameSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the  HTTP/2 setting</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxHeaderListSize"></a><code>maxHeaderListSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the  HTTP/2 setting</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pushEnabled"></a><code>pushEnabled</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the  HTTP/2 setting</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="HttpClientOptions">HttpClientOptions</h2>
<div class="sectionbody">
 Options describing how an link will make connections.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="alpnVersions"></a><code>alpnVersions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of <a href="enums.html#HttpVersion">HttpVersion</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation.
 When the list is empty, the client provides a best effort list according to link:
</p><p class="tableblock"> <ul>
   <li>: [ "h2", "http/1.1" ]</li>
   <li>otherwise: [link]</li>
 </ul></p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="connectTimeout"></a><code>connectTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the connect timeout</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlPaths"></a><code>crlPaths</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL path</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlValues"></a><code>crlValues</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL value</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="defaultHost"></a><code>defaultHost</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the default host name to be used by this client in requests if none is provided when making the request.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="defaultPort"></a><code>defaultPort</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the default port to be used by this client in requests if none is provided when making the request.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledCipherSuites"></a><code>enabledCipherSuites</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled cipher suite, appended to the ordered suites.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledSecureTransportProtocols"></a><code>enabledSecureTransportProtocols</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled SSL/TLS protocols, appended to the ordered protocols.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="http2ClearTextUpgrade"></a><code>http2ClearTextUpgrade</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to <code>true</code> when an <i>h2c</i> connection is established using an HTTP/1.1 upgrade request, and <code>false</code>
 when an <i>h2c</i> connection is established directly (with prior knowledge).</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="http2ConnectionWindowSize"></a><code>http2ConnectionWindowSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the default HTTP/2 connection window size. It overrides the initial window
 size set by link, so the connection window size
 is greater than for its streams, in order the data throughput.
 <p/>
 A value of <code>-1</code> reuses the initial window size setting.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="http2MaxPoolSize"></a><code>http2MaxPoolSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the maximum pool size for HTTP/2 connections</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="http2MultiplexingLimit"></a><code>http2MultiplexingLimit</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number
 of streams the client can create for a connection. The effective number of streams for a
 connection is the min of this value and the server's initial settings.
 <p/>
 Setting the value to <code>-1</code> means to use the value sent by the server's initial settings.
 <code>-1</code> is the default value.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="idleTimeout"></a><code>idleTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the idle timeout, in seconds. zero means don't timeout.
 This determines if a connection will timeout and be closed if no data is received within the timeout.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="initialSettings"></a><code>initialSettings</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#Http2Settings">Http2Settings</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the HTTP/2 connection settings immediately sent by to the server when the client connects.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="jdkSslEngineOptions"></a><code>jdkSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JdkSSLEngineOptions">JdkSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="keepAlive"></a><code>keepAlive</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether keep alive is enabled on the client</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="keyStoreOptions"></a><code>keyStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in jks format, aka Java keystore.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="logActivity"></a><code>logActivity</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxChunkSize"></a><code>maxChunkSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the maximum HTTP chunk size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxPoolSize"></a><code>maxPoolSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the maximum pool size for connections</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxWaitQueueSize"></a><code>maxWaitQueueSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in
 a ConnectionPoolTooBusyException.  If the value is set to a negative number then the queue will be unbounded.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxWebsocketFrameSize"></a><code>maxWebsocketFrameSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the max websocket frame size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="metricsName"></a><code>metricsName</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the metrics name identifying the reported metrics, useful for grouping metrics
 with the same name.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="openSslEngineOptions"></a><code>openSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#OpenSSLEngineOptions">OpenSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemKeyCertOptions"></a><code>pemKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemKeyCertOptions">PemKeyCertOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert store options in pem format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemTrustOptions"></a><code>pemTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemTrustOptions">PemTrustOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pem format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxKeyCertOptions"></a><code>pfxKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in pfx format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxTrustOptions"></a><code>pfxTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pfx format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pipelining"></a><code>pipelining</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether pipe-lining is enabled on the client</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pipeliningLimit"></a><code>pipeliningLimit</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the limit of pending requests a pipe-lined HTTP/1 connection can send.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="protocolVersion"></a><code>protocolVersion</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="enums.html#HttpVersion">HttpVersion</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the protocol version.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="proxyOptions"></a><code>proxyOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#ProxyOptions">ProxyOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="receiveBufferSize"></a><code>receiveBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP receive buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reuseAddress"></a><code>reuseAddress</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of reuse address</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sendBufferSize"></a><code>sendBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP send buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="soLinger"></a><code>soLinger</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SO_linger keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="ssl"></a><code>ssl</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SSL/TLS is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpKeepAlive"></a><code>tcpKeepAlive</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpNoDelay"></a><code>tcpNoDelay</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP no delay is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trafficClass"></a><code>trafficClass</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of traffic class</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trustAll"></a><code>trustAll</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether all server certificates should be trusted</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trustStoreOptions"></a><code>trustStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in jks format, aka Java trustore</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tryUseCompression"></a><code>tryUseCompression</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether compression is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="useAlpn"></a><code>useAlpn</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the ALPN usage.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="usePooledBuffers"></a><code>usePooledBuffers</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether Netty pooled buffers are enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="verifyHost"></a><code>verifyHost</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether hostname verification is enabled</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="HttpServerOptions">HttpServerOptions</h2>
<div class="sectionbody">
 Represents options used by an link instance
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="acceptBacklog"></a><code>acceptBacklog</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the accept back log</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="alpnVersions"></a><code>alpnVersions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of <a href="enums.html#HttpVersion">HttpVersion</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clientAuth"></a><code>clientAuth</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="enums.html#ClientAuth">ClientAuth</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether client auth is required</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clientAuthRequired"></a><code>clientAuthRequired</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether client auth is required</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="compressionSupported"></a><code>compressionSupported</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether the server supports compression</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlPaths"></a><code>crlPaths</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL path</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlValues"></a><code>crlValues</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL value</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledCipherSuites"></a><code>enabledCipherSuites</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled cipher suite, appended to the ordered suites.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledSecureTransportProtocols"></a><code>enabledSecureTransportProtocols</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled SSL/TLS protocols, appended to the ordered protocols.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="handle100ContinueAutomatically"></a><code>handle100ContinueAutomatically</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether 100 Continue should be handled automatically</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="host"></a><code>host</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the host</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="http2ConnectionWindowSize"></a><code>http2ConnectionWindowSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the default HTTP/2 connection window size. It overrides the initial window
 size set by link, so the connection window size
 is greater than for its streams, in order the data throughput.
 <p/>
 A value of <code>-1</code> reuses the initial window size setting.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="idleTimeout"></a><code>idleTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the idle timeout, in seconds. zero means don't timeout.
 This determines if a connection will timeout and be closed if no data is received within the timeout.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="initialSettings"></a><code>initialSettings</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#Http2Settings">Http2Settings</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the HTTP/2 connection settings immediatly sent by the server when a client connects.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="jdkSslEngineOptions"></a><code>jdkSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JdkSSLEngineOptions">JdkSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="keyStoreOptions"></a><code>keyStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in jks format, aka Java keystore.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="logActivity"></a><code>logActivity</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxChunkSize"></a><code>maxChunkSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the maximum HTTP chunk size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxHeaderSize"></a><code>maxHeaderSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the maximum length of all headers for HTTP/1.x .</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxInitialLineLength"></a><code>maxInitialLineLength</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the maximum length of the initial line for HTTP/1.x (e.g. <code>"GET / HTTP/1.0"</code>)</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxWebsocketFrameSize"></a><code>maxWebsocketFrameSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the maximum websocket frames size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="openSslEngineOptions"></a><code>openSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#OpenSSLEngineOptions">OpenSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemKeyCertOptions"></a><code>pemKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemKeyCertOptions">PemKeyCertOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert store options in pem format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemTrustOptions"></a><code>pemTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemTrustOptions">PemTrustOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pem format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxKeyCertOptions"></a><code>pfxKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in pfx format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxTrustOptions"></a><code>pfxTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pfx format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="port"></a><code>port</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the port</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="receiveBufferSize"></a><code>receiveBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP receive buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reuseAddress"></a><code>reuseAddress</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of reuse address</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sendBufferSize"></a><code>sendBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP send buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="soLinger"></a><code>soLinger</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SO_linger keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="ssl"></a><code>ssl</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SSL/TLS is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpKeepAlive"></a><code>tcpKeepAlive</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpNoDelay"></a><code>tcpNoDelay</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP no delay is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trafficClass"></a><code>trafficClass</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of traffic class</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trustStoreOptions"></a><code>trustStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in jks format, aka Java trustore</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="useAlpn"></a><code>useAlpn</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the ALPN usage.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="usePooledBuffers"></a><code>usePooledBuffers</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether Netty pooled buffers are enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="websocketSubProtocols"></a><code>websocketSubProtocols</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the websocket subprotocols supported by the server.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="JdkSSLEngineOptions">JdkSSLEngineOptions</h2>
<div class="sectionbody">
 Configures a link to use the JDK ssl engine implementation.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="alpnAvailable"></a><code>alpnAvailable</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="JksOptions">JksOptions</h2>
<div class="sectionbody">
 Key or trust store options configuring private key and/or certificates based on Java Keystore files.
 <p>
 When used as a key store, it should point to a store containing a private key and its certificate.
 When used as a trust store, it should point to a store containing a list of trusted certificates.
 <p>
 The store can either be loaded by Vert.x from the filesystem:
 <p>
 <pre>
 HttpServerOptions options = HttpServerOptions.httpServerOptions();
 options.setKeyStore(new JKSOptions().setPath("/mykeystore.jks").setPassword("foo"));
 </pre>

 Or directly provided as a buffer:
 <p>

 <pre>
 Buffer store = vertx.fileSystem().readFileSync("/mykeystore.jks");
 options.setKeyStore(new JKSOptions().setValue(store).setPassword("foo"));
 </pre>
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="password"></a><code>password</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the password for the key store</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="path"></a><code>path</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the path to the key store</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="value"></a><code>value</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key store as a buffer</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="MetricsOptions">MetricsOptions</h2>
<div class="sectionbody">
 Vert.x metrics base configuration, this class can be extended by provider implementations to configure
 those specific implementations.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabled"></a><code>enabled</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether metrics will be enabled on the Vert.x instance.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="NetClientOptions">NetClientOptions</h2>
<div class="sectionbody">
 Options for configuring a link.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="connectTimeout"></a><code>connectTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the connect timeout</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlPaths"></a><code>crlPaths</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL path</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlValues"></a><code>crlValues</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL value</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledCipherSuites"></a><code>enabledCipherSuites</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled cipher suite, appended to the ordered suites.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledSecureTransportProtocols"></a><code>enabledSecureTransportProtocols</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled SSL/TLS protocols, appended to the ordered protocols.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="hostnameVerificationAlgorithm"></a><code>hostnameVerificationAlgorithm</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the hostname verification algorithm interval
 To disable hostname verification, set hostnameVerificationAlgorithm to an empty String</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="idleTimeout"></a><code>idleTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the idle timeout, in seconds. zero means don't timeout.
 This determines if a connection will timeout and be closed if no data is received within the timeout.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="jdkSslEngineOptions"></a><code>jdkSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JdkSSLEngineOptions">JdkSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="keyStoreOptions"></a><code>keyStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in jks format, aka Java keystore.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="logActivity"></a><code>logActivity</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="metricsName"></a><code>metricsName</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the metrics name identifying the reported metrics, useful for grouping metrics
 with the same name.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="openSslEngineOptions"></a><code>openSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#OpenSSLEngineOptions">OpenSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemKeyCertOptions"></a><code>pemKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemKeyCertOptions">PemKeyCertOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert store options in pem format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemTrustOptions"></a><code>pemTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemTrustOptions">PemTrustOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pem format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxKeyCertOptions"></a><code>pfxKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in pfx format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxTrustOptions"></a><code>pfxTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pfx format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="proxyOptions"></a><code>proxyOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#ProxyOptions">ProxyOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="receiveBufferSize"></a><code>receiveBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP receive buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reconnectAttempts"></a><code>reconnectAttempts</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of reconnect attempts</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reconnectInterval"></a><code>reconnectInterval</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the reconnect interval</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reuseAddress"></a><code>reuseAddress</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of reuse address</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sendBufferSize"></a><code>sendBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP send buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="soLinger"></a><code>soLinger</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SO_linger keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="ssl"></a><code>ssl</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SSL/TLS is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpKeepAlive"></a><code>tcpKeepAlive</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpNoDelay"></a><code>tcpNoDelay</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP no delay is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trafficClass"></a><code>trafficClass</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of traffic class</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trustAll"></a><code>trustAll</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether all server certificates should be trusted</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trustStoreOptions"></a><code>trustStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in jks format, aka Java trustore</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="useAlpn"></a><code>useAlpn</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the ALPN usage.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="usePooledBuffers"></a><code>usePooledBuffers</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether Netty pooled buffers are enabled</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="NetServerOptions">NetServerOptions</h2>
<div class="sectionbody">
 Options for configuring a link.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="acceptBacklog"></a><code>acceptBacklog</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the accept back log</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clientAuth"></a><code>clientAuth</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="enums.html#ClientAuth">ClientAuth</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether client auth is required</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clientAuthRequired"></a><code>clientAuthRequired</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether client auth is required</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlPaths"></a><code>crlPaths</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL path</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlValues"></a><code>crlValues</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL value</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledCipherSuites"></a><code>enabledCipherSuites</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled cipher suite, appended to the ordered suites.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledSecureTransportProtocols"></a><code>enabledSecureTransportProtocols</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled SSL/TLS protocols, appended to the ordered protocols.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="host"></a><code>host</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the host</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="idleTimeout"></a><code>idleTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the idle timeout, in seconds. zero means don't timeout.
 This determines if a connection will timeout and be closed if no data is received within the timeout.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="jdkSslEngineOptions"></a><code>jdkSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JdkSSLEngineOptions">JdkSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="keyStoreOptions"></a><code>keyStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in jks format, aka Java keystore.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="logActivity"></a><code>logActivity</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="openSslEngineOptions"></a><code>openSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#OpenSSLEngineOptions">OpenSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemKeyCertOptions"></a><code>pemKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemKeyCertOptions">PemKeyCertOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert store options in pem format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemTrustOptions"></a><code>pemTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemTrustOptions">PemTrustOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pem format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxKeyCertOptions"></a><code>pfxKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in pfx format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxTrustOptions"></a><code>pfxTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pfx format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="port"></a><code>port</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the port</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="receiveBufferSize"></a><code>receiveBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP receive buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reuseAddress"></a><code>reuseAddress</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of reuse address</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sendBufferSize"></a><code>sendBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP send buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="soLinger"></a><code>soLinger</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SO_linger keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="ssl"></a><code>ssl</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SSL/TLS is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpKeepAlive"></a><code>tcpKeepAlive</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpNoDelay"></a><code>tcpNoDelay</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP no delay is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trafficClass"></a><code>trafficClass</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of traffic class</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trustStoreOptions"></a><code>trustStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in jks format, aka Java trustore</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="useAlpn"></a><code>useAlpn</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the ALPN usage.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="usePooledBuffers"></a><code>usePooledBuffers</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether Netty pooled buffers are enabled</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="NetworkOptions">NetworkOptions</h2>
<div class="sectionbody">

<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="logActivity"></a><code>logActivity</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="receiveBufferSize"></a><code>receiveBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP receive buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reuseAddress"></a><code>reuseAddress</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of reuse address</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sendBufferSize"></a><code>sendBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP send buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trafficClass"></a><code>trafficClass</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of traffic class</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="OpenOptions">OpenOptions</h2>
<div class="sectionbody">
 Describes how an link should be opened.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="create"></a><code>create</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether the file should be created if it does not already exist.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="createNew"></a><code>createNew</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether the file should be created and fail if it does exist already.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="deleteOnClose"></a><code>deleteOnClose</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether the file should be deleted when it's closed, or the JVM is shutdown.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="dsync"></a><code>dsync</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether every write to the file's content  ill be written synchronously to the underlying hardware.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="perms"></a><code>perms</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the permissions string</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="read"></a><code>read</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether the file is to be opened for reading</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sparse"></a><code>sparse</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether a hint should be provided that the file to created is sparse</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sync"></a><code>sync</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether every write to the file's content and meta-data will be written synchronously to the underlying hardware.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="truncateExisting"></a><code>truncateExisting</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether the file should be truncated to zero length on opening if it exists and is opened for write</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="write"></a><code>write</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether the file is to be opened for writing</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="OpenSSLEngineOptions">OpenSSLEngineOptions</h2>
<div class="sectionbody">
 Configures a link to use OpenSsl.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="alpnAvailable"></a><code>alpnAvailable</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="available"></a><code>available</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sessionCacheEnabled"></a><code>sessionCacheEnabled</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether session cache is enabled in open SSL session server context</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="Option">Option</h2>
<div class="sectionbody">
 Models command line options. Options are values passed to a command line interface using -x or --x. Supported
 syntaxes depend on the parser.
 <p/>
 Short name is generally used with a single dash, while long name requires a double-dash.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="argName"></a><code>argName</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets te arg name for this option.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="choices"></a><code>choices</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the list of values accepted by this option. If the value set by the user does not match once of these
 values, a link exception is thrown.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="defaultValue"></a><code>defaultValue</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the default value of this option</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="description"></a><code>description</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets te description of this option.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="flag"></a><code>flag</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configures the current link to be a flag. It will be evaluated to <code>true</code> if it's found in
 the command line. If you need a flag that may receive a value, use, in this order:
 <code><pre>
   option.setFlag(true).setSingleValued(true)
 </pre></code></p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="help"></a><code>help</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets whether or not this option is a "help" option</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="hidden"></a><code>hidden</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets whether or not this option should be hidden</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="longName"></a><code>longName</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the long name of this option.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="multiValued"></a><code>multiValued</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets whether or not this option can receive several values.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="name"></a><code>name</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="required"></a><code>required</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets whether or not this option is mandatory.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="shortName"></a><code>shortName</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the short name of this option.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="singleValued"></a><code>singleValued</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets whether or not this option can receive a value.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="PemKeyCertOptions">PemKeyCertOptions</h2>
<div class="sectionbody">
 Key store options configuring a private key and its certificate based on
 <i>Privacy-enhanced Electronic Email</i> (PEM) files.
 <p>

 The key file must contain a <b>non encrypted</b> private key in <b>PKCS8</b> format wrapped in a PEM
 block, for example:
 <p>

 <pre>
 -----BEGIN PRIVATE KEY-----
 MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDV6zPk5WqLwS0a
 ...
 K5xBhtm1AhdnZjx5KfW3BecE
 -----END PRIVATE KEY-----
 </pre><p>

 The certificate file must contain an X.509 certificate wrapped in a PEM block, for example:
 <p>

 <pre>
 -----BEGIN CERTIFICATE-----
 MIIDezCCAmOgAwIBAgIEZOI/3TANBgkqhkiG9w0BAQsFADBuMRAwDgYDVQQGEwdV
 ...
 +tmLSvYS39O2nqIzzAUfztkYnUlZmB0l/mKkVqbGJA==
 -----END CERTIFICATE-----
 </pre>

 The key and certificate can either be loaded by Vert.x from the filesystem:
 <p>
 <pre>
 HttpServerOptions options = new HttpServerOptions();
 options.setPemKeyCertOptions(new PemKeyCertOptions().setKeyPath("/mykey.pem").setCertPath("/mycert.pem"));
 </pre>

 Or directly provided as a buffer:<p>

 <pre>
 Buffer key = vertx.fileSystem().readFileSync("/mykey.pem");
 Buffer cert = vertx.fileSystem().readFileSync("/mycert.pem");
 options.setPemKeyCertOptions(new PemKeyCertOptions().setKeyValue(key).setCertValue(cert));
 </pre>
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="certPath"></a><code>certPath</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the path to the certificate</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="certValue"></a><code>certValue</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the certificate as a buffer</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="keyPath"></a><code>keyPath</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the path to the key file</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="keyValue"></a><code>keyValue</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key a a buffer</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="PemTrustOptions">PemTrustOptions</h2>
<div class="sectionbody">
 Certificate Authority options configuring certificates based on
 <i>Privacy-enhanced Electronic Email</i> (PEM) files. The options is configured with a list of
 validating certificates.
 <p>
 Validating certificates must contain X.509 certificates wrapped in a PEM block:<p>

 <pre>
 -----BEGIN CERTIFICATE-----
 MIIDezCCAmOgAwIBAgIEVmLkwTANBgkqhkiG9w0BAQsFADBuMRAwDgYDVQQGEwdV
 ...
 z5+DuODBJUQst141Jmgq8bS543IU/5apcKQeGNxEyQ==
 -----END CERTIFICATE-----
 </pre>

 The certificates can either be loaded by Vert.x from the filesystem:
 <p>
 <pre>
 HttpServerOptions options = new HttpServerOptions();
 options.setPemTrustOptions(new PemTrustOptions().addCertPath("/cert.pem"));
 </pre>

 Or directly provided as a buffer:
 <p>

 <pre>
 Buffer cert = vertx.fileSystem().readFileSync("/cert.pem");
 HttpServerOptions options = new HttpServerOptions();
 options.setPemTrustOptions(new PemTrustOptions().addCertValue(cert));
 </pre>
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="certPaths"></a><code>certPaths</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a certificate path</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="certValues"></a><code>certValues</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a certificate value</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="PfxOptions">PfxOptions</h2>
<div class="sectionbody">
 Key or trust store options configuring private key and/or certificates based on PKCS#12 files.
 <p>
 When used as a key store, it should point to a store containing a private key and its certificate.
 When used as a trust store, it should point to a store containing a list of accepted certificates.
 <p>

 The store can either be loaded by Vert.x from the filesystem:
 <p>
 <pre>
 HttpServerOptions options = new HttpServerOptions();
 options.setPfxKeyCertOptions(new PfxOptions().setPath("/mykeystore.p12").setPassword("foo"));
 </pre>

 Or directly provided as a buffer:<p>

 <pre>
 Buffer store = vertx.fileSystem().readFileSync("/mykeystore.p12");
 options.setPfxKeyCertOptions(new PfxOptions().setValue(store).setPassword("foo"));
 </pre>
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="password"></a><code>password</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the password</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="path"></a><code>path</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the path</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="value"></a><code>value</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the store as a buffer</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="ProxyOptions">ProxyOptions</h2>
<div class="sectionbody">
 Proxy options for a net client or a net client.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="host"></a><code>host</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set proxy host.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="password"></a><code>password</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set proxy password.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="port"></a><code>port</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set proxy port.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="type"></a><code>type</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="enums.html#ProxyType">ProxyType</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set proxy type.
</p><p class="tableblock"> <p>ProxyType can be HTTP, SOCKS4 and SOCKS5</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="username"></a><code>username</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set proxy username.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="TCPSSLOptions">TCPSSLOptions</h2>
<div class="sectionbody">
 Base class. TCP and SSL related options
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlPaths"></a><code>crlPaths</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL path</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="crlValues"></a><code>crlValues</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of Buffer</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add a CRL value</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledCipherSuites"></a><code>enabledCipherSuites</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled cipher suite, appended to the ordered suites.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="enabledSecureTransportProtocols"></a><code>enabledSecureTransportProtocols</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Array of String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add an enabled SSL/TLS protocols, appended to the ordered protocols.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="idleTimeout"></a><code>idleTimeout</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the idle timeout, in seconds. zero means don't timeout.
 This determines if a connection will timeout and be closed if no data is received within the timeout.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="jdkSslEngineOptions"></a><code>jdkSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JdkSSLEngineOptions">JdkSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="keyStoreOptions"></a><code>keyStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in jks format, aka Java keystore.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="logActivity"></a><code>logActivity</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="openSslEngineOptions"></a><code>openSslEngineOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#OpenSSLEngineOptions">OpenSSLEngineOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemKeyCertOptions"></a><code>pemKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemKeyCertOptions">PemKeyCertOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert store options in pem format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pemTrustOptions"></a><code>pemTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PemTrustOptions">PemTrustOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pem format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxKeyCertOptions"></a><code>pfxKeyCertOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the key/cert options in pfx format.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="pfxTrustOptions"></a><code>pfxTrustOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#PfxOptions">PfxOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in pfx format</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="receiveBufferSize"></a><code>receiveBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP receive buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="reuseAddress"></a><code>reuseAddress</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of reuse address</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sendBufferSize"></a><code>sendBufferSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the TCP send buffer size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="soLinger"></a><code>soLinger</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SO_linger keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="ssl"></a><code>ssl</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether SSL/TLS is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpKeepAlive"></a><code>tcpKeepAlive</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP keep alive is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="tcpNoDelay"></a><code>tcpNoDelay</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether TCP no delay is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trafficClass"></a><code>trafficClass</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of traffic class</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="trustStoreOptions"></a><code>trustStoreOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#JksOptions">JksOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the trust options in jks format, aka Java trustore</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="useAlpn"></a><code>useAlpn</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the ALPN usage.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="usePooledBuffers"></a><code>usePooledBuffers</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether Netty pooled buffers are enabled</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="VertxOptions">VertxOptions</h2>
<div class="sectionbody">
 Instances of this class are used to configure link instances.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="addressResolverOptions"></a><code>addressResolverOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#AddressResolverOptions">AddressResolverOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the address resolver configuration to configure resolving DNS servers, cache TTL, etc...</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="blockedThreadCheckInterval"></a><code>blockedThreadCheckInterval</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the value of blocked thread check period, in ms.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clusterHost"></a><code>clusterHost</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the hostname to be used for clustering.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clusterPingInterval"></a><code>clusterPingInterval</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of cluster ping interval, in ms.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clusterPingReplyInterval"></a><code>clusterPingReplyInterval</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of cluster ping reply interval, in ms.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clusterPort"></a><code>clusterPort</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the port to be used for clustering.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clusterPublicHost"></a><code>clusterPublicHost</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the public facing hostname to be used for clustering.
 Sometimes, e.g. when running on certain clouds, the local address the server listens on for clustering is not the same
 address that other nodes connect to it at, as the OS / cloud infrastructure does some kind of proxying.
 If this is the case you can specify a public hostname which is different from the hostname the server listens at.
 The default value is null which means use the same as the cluster hostname.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clusterPublicPort"></a><code>clusterPublicPort</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">See link for an explanation.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="clustered"></a><code>clustered</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether or not the Vert.x instance will be clustered.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="eventBusOptions"></a><code>eventBusOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#EventBusOptions">EventBusOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the event bus configuration to configure the host, port, ssl...</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="eventLoopPoolSize"></a><code>eventLoopPoolSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the number of event loop threads to be used by the Vert.x instance.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="haEnabled"></a><code>haEnabled</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether HA will be enabled on the Vert.x instance.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="haGroup"></a><code>haGroup</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the HA group to be used when HA is enabled.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="internalBlockingPoolSize"></a><code>internalBlockingPoolSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the value of internal blocking pool size</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxEventLoopExecuteTime"></a><code>maxEventLoopExecuteTime</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the value of max event loop execute time, in ns.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="maxWorkerExecuteTime"></a><code>maxWorkerExecuteTime</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the value of max worker execute time, in ns.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="metricsOptions"></a><code>metricsOptions</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="dataobjects.html#MetricsOptions">MetricsOptions</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the metrics options</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="quorumSize"></a><code>quorumSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the quorum size to be used when HA is enabled.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="warningExceptionTime"></a><code>warningExceptionTime</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the threshold value above this, the blocked warning contains a stack trace.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="workerPoolSize"></a><code>workerPoolSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the maximum number of worker threads to be used by the Vert.x instance.</p></td>
</tr>
</tbody>
</table>
</div>
</div>

        

        
          <div id="footer">
            <div id="footer-text">
              
                Last updated 2016-09-12 08:38:04 CEST
              
              
            </div>
          </div>
        
      </div>
    </div>
  </div>
</div>

<footer>
  <div class="container">
    <div class="row">
      <div class="col-xs-6 col-sm-3 col-md-3 col-lg-2">
        <h2>Vert.x</h2>
        <ul class="list-unstyled">
          <li><a href="http://vertx.io/">Home</a></li>
          <li><a href="http://vertx.io/download/">Download</a></li>
          <li><a href="http://vertx.io/docs/">Documentation</a></li>
          <li><a href="https://github.com/vert-x3/wiki/wiki">Wiki</a></li>
          <li><a href="http://vertx.io/blog/">Blog</a></li>
          <li><a href="http://vertx.io/vertx2/" class="vertx-2-link">Vert.x 2</a></li>
        </ul>
      </div>
      <div class="col-xs-6 col-sm-3 col-md-3 col-lg-2">
        <h2>Community</h2>
        <ul class="list-unstyled">
          <li><a href="http://vertx.io/community/">Help &amp; Contributors</a></li>
          <li><a href="http://vertx.io/materials/">Learning materials</a></li>
          <li><a href="https://groups.google.com/forum/?fromgroups#!forum/vertx">User Group</a></li>
          <li><a href="https://groups.google.com/forum/?fromgroups#!forum/vertx-dev">Developer Group</a></li>
        </ul>
      </div>

      <div class="col-xs-12 col-sm-6 col-lg-offset-2 col-md-6 copyright">
        <p>Vert.x is open source and dual licensed under the <a href="https://www.eclipse.org/org/documents/epl-v10.php">Eclipse Public License 1.0</a> and <a href="https://www.apache.org/licenses/LICENSE-2.0.html">Apache License 2.0</a>.</p>
        <p>This website is licensed under the <a href="http://creativecommons.org/licenses/by-sa/3.0/">CC BY-SA 3.0 License</a>.<br>
        Design by <a href="http://www.michel-kraemer.com">Michel Kr&auml;mer</a>. <a href="http://www.entypo.com">Entypo pictograms</a> by Daniel Bruce.</p>
        <div class="row">
          <div class="col-xs-12 col-lg-offset-1 col-md-5">
            <a href="http://eclipse.org">
            <img class="logo eclipse-logo" src="http://vertx.io/assets/eclipse_logo_grey_small.png" width="204" height="48">
            </a>
          </div>
          <div class="col-xs-12 col-md-offset-2 col-lg-offset-0 col-md-5">
            <a href="http://cloudbees.com">
            <img class="logo cloudbees-logo" src="http://vertx.io/assets/Button-Built-on-CB-1-grey.png" width="180" height="48">
           </a>
          </div>
          <div class="col-xs-12 col-md-offset-2 col-lg-offset-1 col-md-5 jprofiler">
            <a href="http://www.ej-technologies.com/products/jprofiler/overview.html"
            style="text-decoration:none">
            <img class="logo jprofiler-logo" src="http://vertx.io/assets/jprofiler-logo.png" width="48" height="48"><span class="jprofiler-logo">&nbsp; JPROFILER</span>
            </a>
          </div>
        </div>
      </div>
    </div>
  </div>
</footer>

<script src="http://static.jboss.org/theme/js/libs/jquery/jquery-1.9.1.min.js"></script>
<script src="http://vertx.io/javascripts/bootstrap.min.js"></script>
<script src="http://vertx.io/javascripts/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>



<script src="http://vertx.io/javascripts/sidebar.js"></script>


</body>
</html>
